home *** CD-ROM | disk | FTP | other *** search
/ Practical Internet Web Designer 89 / PIWD89.iso / pc / CONTENTS / BONUS / FULL / wikiwriter / setup-ww2x.exe / {app} / help / start.db < prev    next >
Text File  |  2003-12-04  |  7KB  |  114 lines

  1. @@title WikiWriter Help: Getting Started
  2. @@inc helptoc
  3. == Getting Started
  4.  
  5. The features and controls in [[b WikiWriter]] are simple and direct. Here's the quick run-down (see the [[b Tutorial]] for details).
  6.  
  7. === Menu Structure
  8. ==== Viewing
  9. * Project
  10. ** Open Existing
  11. ** Create New
  12. ** Quit
  13. /* 
  14. * Tools
  15. ** Compile to eBook
  16. ** Webify Entire Project
  17. ** Webify This Page Only
  18. /*
  19. * Search
  20. ** Find
  21. ** Results
  22. /* 
  23. * Index
  24. ** Build Index
  25. ** View Index
  26. /*
  27. * Help
  28. ** User Guide
  29. ** About
  30. /*
  31. * Edit Page
  32. * Home
  33. /*
  34. ==== Editing
  35. * Save
  36. * Preview
  37. * Cancel Edits
  38. * Dropdown Lists
  39. ** DIV Styles
  40. ** SPAN Styles
  41. /*
  42. /*
  43. ==== Previewing
  44. ** Edit Page
  45. ** Cancel Edits
  46. /*
  47. /*
  48.  
  49. === Project > Open Existing
  50. [[b WikiWriter]] comes with some projects already built and ready to run. That's just our way of showing the system works! To view the projects, select the [[b Project > Open Existing]], browse to a project directory, and select the [[b Home.db]] file for that directory.
  51.  
  52. === Project > Create New
  53. To create a new project, select the [[b Project > Create New]]. The system will guide you through the process of creating a project directory, then will automatically create the required startup files in that directory. The new project directory will be a sub-directory of the [[b current]] project, so make sure you are where you want to be, before creating a new project. You can move a project directory to another location later if you wish.
  54.  
  55. === Project > Quit
  56. The [[b Quit]] menu option does what you would expect.
  57.  
  58. === Tools > Compile to eBook
  59. (WikiWriter version 3 and above...)
  60.  
  61. === Tools > Webify Entire Project 
  62. To generate a set of HTML files viewable by any browser in a Web, intranet, CDROM, or other HTML-based presentation, select [[b Webify Entire Project]]. WikiWriter will read all the WikiWriter files in the project, adjust the links from wiki-style to HTML, and save each page as an HTML file. A set of HTML files can be converted to ebook or Windows Help format, or Zipped and distributed as-is.
  63.  
  64. === Tools > Webify This Page Only 
  65. To create a single HTML page (for instance, to update just a single page in a webified project), select [[b Tools]], then [[b Webify this Page Only]]. The page will be converted to HTML and placed in the project folder.
  66.  
  67. === Search > Find
  68.  
  69. Start a search by selecting [[b Search]], then [[b Find]]. Enter search words separated by spaces into the edit box, and click [[b Search]] to scan the current project for the target words. The search algorithm looks for each word in the list, in sequence, to determine if the page will listed in the [[b Results]] list. When it finds the first word in a paragraph, [[b WikiWriter]] looks for the second word. If it finds all the words in the list in the same paragraph, the page gets added to the [[b Results]] list. To search for an exact phrase, put the "phrase in quotes", as I just did here.
  70.  
  71. === Search > Results
  72.  
  73. The [[b Results]] option shows the results of a search in a link list. Click on [[b Results]] to see the list, and click on a link on the list to go to that page. To check out the other pages on the list, click the [[b Results]] option again.
  74.  
  75. === Index > Build Index
  76.  
  77. To create or update an index page, select [[b Index > Build Index]]. The program will scan all the pages in the current project, extract index entries, and assemble and format the entries on a page saved with the name [[b wwidx]]. 
  78.  
  79. === Index > View Index
  80.  
  81. Once an index has been built, it can be viewed by selecting [[b Index > View Index]]. 
  82.  
  83. === Help > User Guide
  84. The [[b Help]] option [[b User Guide]] calls up the compiled version of this very file you are reading right now. 
  85. The Help and Tutorial files are embedded into [[b WikiWriter]], so they are accessible anywhere you place wwrite.exe. You can always view look at the [[b Help]] project files with [[b WikiWriter]] directly, if you wish — it's in the [[b Help]] directory in the [[b WikiWriter]] installation.
  86.  
  87. === Help > About
  88. [[b Help > About]] shows the version number, copyright notice, and support access information.
  89.  
  90. === Edit Page
  91. The [[b Edit Page]] button places the source file for the page in the editor.
  92.  
  93. === Home
  94. The [[b Home]] button takes you to the Home page of the project you are viewing.
  95.  
  96. === Editing Functions
  97. While editing a page, you have additional edit-related functions available in the menu bar:
  98. * [[b Edit]] — The [[b Edit]] menu item becomes available, with the usual Undo, Cut, Copy, and Paste functions (also available through a right-mouse-click in the editing window).
  99. * [[b Save]] — Saves your edited file as the source for the page, and saves the previous version into the page's [[b .bak]] file, just in case you change your mind later on.
  100. * [[b Preview]] — Shows how the page will look with the current changes, without committing the changes to the source file. Scroll down to see the Preview display.
  101. * [[b Cancel Edits]] — Bails you out of the editing session without saving the changes. Jumping to another page without first using [[b Save]] will also cancel editing changes.
  102. /*
  103.  
  104. === Dropdown Lists
  105. While you are editing, the [[b DIV Styles]] and [[b SPAN Styles]] dropdown lists show the names and brief descriptions of classes in the Cascading Style Sheet. [[b DIV Styles]] shows styles to use for  blocks of content like menus, boxed chunks of text, and other page-layout elements. [[b SPAN Styles]] apply to inline elements, like bolded or italicized text. 
  106.  
  107. To use the lists to insert style markup, first select text (words, letters, or phrases for SPAN, whole paragraphs for DIV) or just place your cursor as the target in the text. Then click on the list to open it (selected text in the editor lose its highlight but will still be selected), scroll to view the contents of the list, and click on the style you want to insert. Then click on [[b Do]] to the right of your selected style. See ((Markup Syntax)) for instructions on applying styles by direct entry in [[b WikiWriter]] pages. 
  108.  
  109. === While Previewing
  110. The [[b Edit Page]] and [[b Cancel Edits]] buttons are active during Preview.
  111.  
  112. === Project Address Line
  113. In the status line at the bottom of the window, you see a [[b Project:....]] line showing the full path and filename of the page currently displayed in [[b WikiWriter]]. It helps to know you are editing the right project.
  114.